home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmClipboardRegisterFormat.z / XmClipboardRegisterFormat
Text File  |  1998-10-30  |  5KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt - A clipboard function that
  10.           registers a new format
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardRegisterFormat (_d_i_s_p_l_a_y, _f_o_r_m_a_t__n_a_m_e, _f_o_r_m_a_t__l_e_n_g_t_h)
  15.                   Display * _d_i_s_p_l_a_y;
  16.                   char    * _f_o_r_m_a_t__n_a_m_e;
  17.                   int     _f_o_r_m_a_t__l_e_n_g_t_h;
  18.           (vvvvooooiiiidddd)
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt registers a new format. Each
  25.           format stored on the clipboard should have a length
  26.           associated with it; this length must be known to the
  27.           clipboard routines. Formats are known as targets in the
  28.           _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l(ICCCM). All of
  29.           the formats specified by version 1.1 of the ICCCM
  30.           conventions are preregistered. Any other format that the
  31.           application wants to use must either be 8-bit data or be
  32.           registered via this routine.  Failure to register the length
  33.           of the data results in incompatible applications across
  34.           platforms having different byte-swapping orders.
  35.  
  36.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  37.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  38.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  39.  
  40.           _f_o_r_m_a_t__n_a_m_e
  41.                     Specifies the string name for the new format
  42.                     (target).
  43.  
  44.           _f_o_r_m_a_t__l_e_n_g_t_h
  45.                     Specifies the format length in bits (8, 16, or
  46.                     32).
  47.  
  48.      RRRREEEETTTTUUUURRRRNNNN
  49.           _X_m_C_l_i_p_b_o_a_r_d_B_a_d_F_o_r_m_a_t
  50.                     The _f_o_r_m_a_t__n_a_m_e must not be NULL, and the
  51.                     _f_o_r_m_a_t__l_e_n_g_t_hmust be 8, 16, or 32.
  52.  
  53.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  54.                     The function was successful.
  55.  
  56.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  57.                     The function failed because the clipboard was
  58.                     locked by another application. The application can
  59.                     continue to call the function again with the same
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     parameters until the lock goes away. This gives
  75.                     the application the opportunity to ask if the user
  76.                     wants to keep trying or to give up on the
  77.                     operation.
  78.  
  79.           _X_m_C_l_i_p_b_o_a_r_d_F_a_i_l
  80.                     The function failed because the specified format
  81.                     was already registered with a different length
  82.                     from that specified now. If a specified format was
  83.                     already registered with the same length as that
  84.                     specified now, _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s is returned.
  85.  
  86.      RRRREEEELLLLAAAATTTTEEEEDDDD
  87.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3).
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.